Conversation
- fixed package upload waiting workflow - fixing sphinx trying to generate pydantic docstrings - fixed appmetadata jsonscheme --> RST warnings
pyproject-based build processes
better documentation for runtime params
added parameter envelope and `clams envelop` command
fixed bug the envelope not working with cli.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
This release adds an optional JSON "envelope" input format for passing complex or long runtime parameters to apps, migrates the build system to
pyproject.toml, and expands runtime-parameter documentation.Additions
--flag-like CLI args, apps now accept a JSON envelope ({"parameters": {...}, "mmif": {...}}) as input. This enables long prompts and structured (map/array) parameter values that do not fit nicely in URL query strings. The envelope is auto-detected, explicit parameters (query string or cli flags) take priority over envelope values, and app output is always raw MMIF so existing pipelines are unaffected (added parameter envelope andclams envelopcommand #287).clams envelopCLI subcommand and aclams.create_envelope()Python API for constructing envelope JSON from a parameter file (or dict) and an MMIF read from a file or stdin (added parameter envelope andclams envelopcommand #287).Changes
mmif-python1.4.0.setup.pytopyproject.tomlwithsetuptools-scmversioning; the CI and documentation publishing pipeline was standardized accordingly (pyproject-based build processes #286).map-type parameter key (better documentation for runtime params #284).